<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: MapEntry.html 689 2013-06-28 19:22:16Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.jibx;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.util.Iterator;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.util.Map;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>import org.jibx.runtime.JiBXParseException;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>/**<a name="line.15"></a>
<span class="sourceLineNo">016</span> * Utility class that makes it slightly easier to model {@link Map} properties in JiBX.<a name="line.16"></a>
<span class="sourceLineNo">017</span> * This class can be used to represent entries in the map, each of which is modeled in XML as a separate XML element.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> * &lt;p&gt;<a name="line.19"></a>
<span class="sourceLineNo">020</span> * For example, suppose you have a class {@code Company} and want to add a {@code directory} property that has<a name="line.20"></a>
<span class="sourceLineNo">021</span> * type {@code Map&lt;String, Person&gt;}:<a name="line.21"></a>
<span class="sourceLineNo">022</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.22"></a>
<span class="sourceLineNo">023</span> * public class Company {<a name="line.23"></a>
<span class="sourceLineNo">024</span> *     private Map&amp;lt;String, Person&amp;gt; directory = new HashMap&amp;lt;String, Person&amp;gt;();<a name="line.24"></a>
<span class="sourceLineNo">025</span> *<a name="line.25"></a>
<span class="sourceLineNo">026</span> *     // Getter and setter for the "directory" property<a name="line.26"></a>
<span class="sourceLineNo">027</span> *     public Map&amp;lt;String, Person&amp;gt; getDirectory() {<a name="line.27"></a>
<span class="sourceLineNo">028</span> *         return this.directory;<a name="line.28"></a>
<span class="sourceLineNo">029</span> *     }<a name="line.29"></a>
<span class="sourceLineNo">030</span> *     public void setDirectory(Map&amp;lt;String, Person&amp;gt; directory) {<a name="line.30"></a>
<span class="sourceLineNo">031</span> *         this.directory = directory;<a name="line.31"></a>
<span class="sourceLineNo">032</span> *     }<a name="line.32"></a>
<span class="sourceLineNo">033</span> * }<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;p&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> * Because the JiBX binding process modifies class files, you first need to create your own subclass of {@link MapEntry}<a name="line.37"></a>
<span class="sourceLineNo">038</span> * that can be modified. In this example, we'll use an inner class of {@code Company}. In addition, you also need to add<a name="line.38"></a>
<span class="sourceLineNo">039</span> * JiBX "add-method" and "iter-method" helper methods. The resulting new code might look like this:<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> *     // JiBX holder for a single entry in the Directory map<a name="line.41"></a>
<span class="sourceLineNo">042</span> *     public static class DirectoryEntry extends MapEntry&amp;lt;String, Person&amp;gt; {<a name="line.42"></a>
<span class="sourceLineNo">043</span> *        public String getKey()   { return super.getKey();   }   // JiBX requires exact return types<a name="line.43"></a>
<span class="sourceLineNo">044</span> *        public Person getValue() { return super.getValue(); }   // JiBX requires exact return types<a name="line.44"></a>
<span class="sourceLineNo">045</span> *     }<a name="line.45"></a>
<span class="sourceLineNo">046</span> *<a name="line.46"></a>
<span class="sourceLineNo">047</span> *     // JiBX "add-method" that adds a new entry to the directory<a name="line.47"></a>
<span class="sourceLineNo">048</span> *     void addDirectoryEntry(DirectoryEntry entry) throws JiBXParseException {<a name="line.48"></a>
<span class="sourceLineNo">049</span> *         MapEntry.add(this.directory, entry);<a name="line.49"></a>
<span class="sourceLineNo">050</span> *     }<a name="line.50"></a>
<span class="sourceLineNo">051</span> *<a name="line.51"></a>
<span class="sourceLineNo">052</span> *     // JiBX "iter-method" that iterates all entries in the directory<a name="line.52"></a>
<span class="sourceLineNo">053</span> *     Iterator&amp;lt;DirectoryEntry&amp;gt; iterateDirectoryEntries() {<a name="line.53"></a>
<span class="sourceLineNo">054</span> *         return MapEntry.iterate(this.directory, DirectoryEntry.class);<a name="line.54"></a>
<span class="sourceLineNo">055</span> *     }<a name="line.55"></a>
<span class="sourceLineNo">056</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.56"></a>
<span class="sourceLineNo">057</span> *<a name="line.57"></a>
<span class="sourceLineNo">058</span> * &lt;p&gt;<a name="line.58"></a>
<span class="sourceLineNo">059</span> * Then in your JiBX binding definition, you would do something like this:<a name="line.59"></a>
<span class="sourceLineNo">060</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &amp;lt;binding package="com.example"&amp;gt;<a name="line.61"></a>
<span class="sourceLineNo">062</span> *<a name="line.62"></a>
<span class="sourceLineNo">063</span> *     &amp;lt;!-- Include XML mapping definition for a Person object (having type-name "person") --&amp;gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> *     &amp;lt;include path="person.xml"/&amp;gt;<a name="line.64"></a>
<span class="sourceLineNo">065</span> *<a name="line.65"></a>
<span class="sourceLineNo">066</span> *     &amp;lt;!-- Define the XML mapping for one entry in the "directory" map --&amp;gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span> *     &amp;lt;mapping abstract="true" type-name="directory_entry" class="com.example.Company$DirectoryEntry"&amp;gt;<a name="line.67"></a>
<span class="sourceLineNo">068</span> *         &amp;lt;value name="name" get-method="getKey" set-method="setKey" type="java.lang.String" style="attribute"/&amp;gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span> *         &amp;lt;structure name="Person" get-method="getValue" set-method="setValue" map-as="person"/&amp;gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> *     &amp;lt;/mapping&amp;gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span> *<a name="line.71"></a>
<span class="sourceLineNo">072</span> *     &amp;lt;!-- Define XML mapping for a Company object --&amp;gt;<a name="line.72"></a>
<span class="sourceLineNo">073</span> *     &amp;lt;mapping abstract="true" type-name="company" class="com.example.Company"&amp;gt;<a name="line.73"></a>
<span class="sourceLineNo">074</span> *         &amp;lt;collection name="Directory" item-type="com.example.Company$DirectoryEntry"<a name="line.74"></a>
<span class="sourceLineNo">075</span> *           add-method="addDirectoryEntry" iter-method="iterateDirectoryEntries"&amp;gt;<a name="line.75"></a>
<span class="sourceLineNo">076</span> *             &amp;lt;structure name="DirectoryEntry" map-as="directory_entry"/&amp;gt;<a name="line.76"></a>
<span class="sourceLineNo">077</span> *         &amp;lt;/collection&amp;gt;<a name="line.77"></a>
<span class="sourceLineNo">078</span> *         &amp;lt;!-- other properties... --&amp;gt;<a name="line.78"></a>
<span class="sourceLineNo">079</span> *     &amp;lt;/mapping&amp;gt;<a name="line.79"></a>
<span class="sourceLineNo">080</span> * &amp;lt;/binding&amp;gt;<a name="line.80"></a>
<span class="sourceLineNo">081</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span> *<a name="line.82"></a>
<span class="sourceLineNo">083</span> * Then the resulting XML would end up looking something like this:<a name="line.83"></a>
<span class="sourceLineNo">084</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.84"></a>
<span class="sourceLineNo">085</span> * &amp;lt;Company&amp;gt;<a name="line.85"></a>
<span class="sourceLineNo">086</span> *     &amp;lt;Directory&amp;gt;<a name="line.86"></a>
<span class="sourceLineNo">087</span> *         &amp;lt;DirectoryEntry name="George Washington"&amp;gt;<a name="line.87"></a>
<span class="sourceLineNo">088</span> *             &amp;lt;Person&amp;gt;<a name="line.88"></a>
<span class="sourceLineNo">089</span> *                  &amp;lt;!-- properties of George Washington... --&amp;gt;<a name="line.89"></a>
<span class="sourceLineNo">090</span> *             &amp;lt;/Person&amp;gt;<a name="line.90"></a>
<span class="sourceLineNo">091</span> *         &amp;lt;/DirectoryEntry&amp;gt;<a name="line.91"></a>
<span class="sourceLineNo">092</span> *         &amp;lt;DirectoryEntry name="Betsy Ross"&amp;gt;<a name="line.92"></a>
<span class="sourceLineNo">093</span> *             &amp;lt;Person&amp;gt;<a name="line.93"></a>
<span class="sourceLineNo">094</span> *                  &amp;lt;!-- properties of Betsy Ross... --&amp;gt;<a name="line.94"></a>
<span class="sourceLineNo">095</span> *             &amp;lt;/Person&amp;gt;<a name="line.95"></a>
<span class="sourceLineNo">096</span> *         &amp;lt;/DirectoryEntry&amp;gt;<a name="line.96"></a>
<span class="sourceLineNo">097</span> *     &amp;lt;/Directory&amp;gt;<a name="line.97"></a>
<span class="sourceLineNo">098</span> *     &amp;lt;!-- other properties... --&amp;gt;<a name="line.98"></a>
<span class="sourceLineNo">099</span> * &amp;lt;/Company&amp;gt;<a name="line.99"></a>
<span class="sourceLineNo">100</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.100"></a>
<span class="sourceLineNo">101</span> *<a name="line.101"></a>
<span class="sourceLineNo">102</span> * &lt;p&gt;<a name="line.102"></a>
<span class="sourceLineNo">103</span> * Note that during unmarshalling, the &lt;code&gt;Map&lt;/code&gt; itself is not created; it is expected to already exist<a name="line.103"></a>
<span class="sourceLineNo">104</span> * and be empty. This will be the case if you provide a field initializer as in the example above.<a name="line.104"></a>
<span class="sourceLineNo">105</span> *<a name="line.105"></a>
<span class="sourceLineNo">106</span> * &lt;p&gt;<a name="line.106"></a>
<span class="sourceLineNo">107</span> * The map keys are not constrained to being simple values: for complex keys, just adjust the mapping for the<a name="line.107"></a>
<span class="sourceLineNo">108</span> * {@code DirectoryEntry} structure accordingly.<a name="line.108"></a>
<span class="sourceLineNo">109</span> */<a name="line.109"></a>
<span class="sourceLineNo">110</span>public class MapEntry&lt;K, V&gt; {<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span>    private K key;<a name="line.112"></a>
<span class="sourceLineNo">113</span>    private V value;<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span>    /**<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * Get this map entry's key.<a name="line.116"></a>
<span class="sourceLineNo">117</span>     */<a name="line.117"></a>
<span class="sourceLineNo">118</span>    public K getKey() {<a name="line.118"></a>
<span class="sourceLineNo">119</span>        return this.key;<a name="line.119"></a>
<span class="sourceLineNo">120</span>    }<a name="line.120"></a>
<span class="sourceLineNo">121</span>    public void setKey(K key) {<a name="line.121"></a>
<span class="sourceLineNo">122</span>        this.key = key;<a name="line.122"></a>
<span class="sourceLineNo">123</span>    }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span>    /**<a name="line.125"></a>
<span class="sourceLineNo">126</span>     * Get this map entry's value.<a name="line.126"></a>
<span class="sourceLineNo">127</span>     */<a name="line.127"></a>
<span class="sourceLineNo">128</span>    public V getValue() {<a name="line.128"></a>
<span class="sourceLineNo">129</span>        return this.value;<a name="line.129"></a>
<span class="sourceLineNo">130</span>    }<a name="line.130"></a>
<span class="sourceLineNo">131</span>    public void setValue(V value) {<a name="line.131"></a>
<span class="sourceLineNo">132</span>        this.value = value;<a name="line.132"></a>
<span class="sourceLineNo">133</span>    }<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span>    /**<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * Helper method intended to be used by a custom JiBX "iter-method".<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * This method returns an iterator that iterates over all entries in the given map.<a name="line.137"></a>
<span class="sourceLineNo">138</span>     *<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * @param &lt;K&gt; type of map keys<a name="line.139"></a>
<span class="sourceLineNo">140</span>     * @param &lt;V&gt; type of map values<a name="line.140"></a>
<span class="sourceLineNo">141</span>     * @param map map to iterate<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * @param entryClass the subclass of {@link MapEntry} used for iterated elements; must have a default constructor<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * @return map entry iterator<a name="line.143"></a>
<span class="sourceLineNo">144</span>     */<a name="line.144"></a>
<span class="sourceLineNo">145</span>    public static &lt;K, V, E extends MapEntry&lt;K, V&gt;&gt; Iterator&lt;E&gt; iterate(Map&lt;K, V&gt; map, final Class&lt;E&gt; entryClass) {<a name="line.145"></a>
<span class="sourceLineNo">146</span>        final Iterator&lt;Map.Entry&lt;K, V&gt;&gt; entryIterator = map.entrySet().iterator();<a name="line.146"></a>
<span class="sourceLineNo">147</span>        return new Iterator&lt;E&gt;() {<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span>            @Override<a name="line.149"></a>
<span class="sourceLineNo">150</span>            public boolean hasNext() {<a name="line.150"></a>
<span class="sourceLineNo">151</span>                return entryIterator.hasNext();<a name="line.151"></a>
<span class="sourceLineNo">152</span>            }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span>            @Override<a name="line.154"></a>
<span class="sourceLineNo">155</span>            public E next() {<a name="line.155"></a>
<span class="sourceLineNo">156</span>                Map.Entry&lt;K, V&gt; entry = entryIterator.next();<a name="line.156"></a>
<span class="sourceLineNo">157</span>                E mapEntry;<a name="line.157"></a>
<span class="sourceLineNo">158</span>                try {<a name="line.158"></a>
<span class="sourceLineNo">159</span>                    mapEntry = entryClass.newInstance();<a name="line.159"></a>
<span class="sourceLineNo">160</span>                } catch (Exception e) {<a name="line.160"></a>
<span class="sourceLineNo">161</span>                    throw new RuntimeException("unexpected exception", e);<a name="line.161"></a>
<span class="sourceLineNo">162</span>                }<a name="line.162"></a>
<span class="sourceLineNo">163</span>                mapEntry.setKey(entry.getKey());<a name="line.163"></a>
<span class="sourceLineNo">164</span>                mapEntry.setValue(entry.getValue());<a name="line.164"></a>
<span class="sourceLineNo">165</span>                return mapEntry;<a name="line.165"></a>
<span class="sourceLineNo">166</span>            }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span>            @Override<a name="line.168"></a>
<span class="sourceLineNo">169</span>            public void remove() {<a name="line.169"></a>
<span class="sourceLineNo">170</span>                entryIterator.remove();<a name="line.170"></a>
<span class="sourceLineNo">171</span>            }<a name="line.171"></a>
<span class="sourceLineNo">172</span>        };<a name="line.172"></a>
<span class="sourceLineNo">173</span>    }<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span>    /**<a name="line.175"></a>
<span class="sourceLineNo">176</span>     * Helper method intended to be used by a custom JiBX "add-method".<a name="line.176"></a>
<span class="sourceLineNo">177</span>     * If there is an existing entry with the same key, a {@link JiBXParseException} is thrown.<a name="line.177"></a>
<span class="sourceLineNo">178</span>     *<a name="line.178"></a>
<span class="sourceLineNo">179</span>     * @param map map to which to add an new entry<a name="line.179"></a>
<span class="sourceLineNo">180</span>     * @param entry new entry to add<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * @throws JiBXParseException if the map already contains an entry with the given key<a name="line.181"></a>
<span class="sourceLineNo">182</span>     */<a name="line.182"></a>
<span class="sourceLineNo">183</span>    public static &lt;K, V&gt; void add(Map&lt;K, V&gt; map, MapEntry&lt;? extends K, ? extends V&gt; entry) throws JiBXParseException {<a name="line.183"></a>
<span class="sourceLineNo">184</span>        MapEntry.add(map, entry, false);<a name="line.184"></a>
<span class="sourceLineNo">185</span>    }<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span>    /**<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * Helper method intended to be used by a custom JiBX "add-method".<a name="line.188"></a>
<span class="sourceLineNo">189</span>     *<a name="line.189"></a>
<span class="sourceLineNo">190</span>     * @param map map to which to add an new entry<a name="line.190"></a>
<span class="sourceLineNo">191</span>     * @param entry new entry to add<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * @param allowDuplicate {@code true} to replace any existing entry having the same key,<a name="line.192"></a>
<span class="sourceLineNo">193</span>     *  or {@code false} to throw a {@link JiBXParseException} if there is an existing entry<a name="line.193"></a>
<span class="sourceLineNo">194</span>     * @throws JiBXParseException if {@code allowDuplicate} is {@code false} and an entry<a name="line.194"></a>
<span class="sourceLineNo">195</span>     *  with the same key already exists in {@code map}<a name="line.195"></a>
<span class="sourceLineNo">196</span>     */<a name="line.196"></a>
<span class="sourceLineNo">197</span>    public static &lt;K, V&gt; void add(Map&lt;K, V&gt; map, MapEntry&lt;? extends K, ? extends V&gt; entry, boolean allowDuplicate)<a name="line.197"></a>
<span class="sourceLineNo">198</span>      throws JiBXParseException {<a name="line.198"></a>
<span class="sourceLineNo">199</span>        K key = entry.getKey();<a name="line.199"></a>
<span class="sourceLineNo">200</span>        V value = entry.getValue();<a name="line.200"></a>
<span class="sourceLineNo">201</span>        if (!allowDuplicate &amp;&amp; map.containsKey(key))<a name="line.201"></a>
<span class="sourceLineNo">202</span>            throw new JiBXParseException("duplicate key in map", "" + key);<a name="line.202"></a>
<span class="sourceLineNo">203</span>        map.put(key, value);<a name="line.203"></a>
<span class="sourceLineNo">204</span>    }<a name="line.204"></a>
<span class="sourceLineNo">205</span>}<a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>




























































</pre>
</div>
</body>
</html>
